home *** CD-ROM | disk | FTP | other *** search
/ Aminet 25 / Aminet 25 (1998)(GTI - Schatztruhe)[!][Jun 1998].iso / Aminet / dev / misc / Revisor11.readme < prev    next >
Encoding:
Text File  |  1998-05-05  |  9.6 KB  |  348 lines
  1. Short:    Revisor V1.1  Version and revision bump utility.
  2. Author:   cscholling@t-online.de (Carsten Scholling)
  3. Uploader: cscholling@t-online.de (Carsten Scholling)
  4. Version:  1.1
  5. Type:     dev/misc
  6. Requires: OS2.x
  7. Replaces: dev/misc/Revisor.lha
  8.  
  9.  
  10.  
  11. Description:
  12. ¯¯¯¯¯¯¯¯¯¯¯
  13. Revisor  is  a  util for creating version/revision files for C and ASM.  It also
  14. allows  easy version and revision bumping.  And Revisor uses NO "brain"-files to
  15. store  it's information, because all needed information for bumping is read from
  16. the revision files itself.
  17.  
  18.  
  19.  
  20. History:
  21. ¯¯¯¯¯¯¯
  22. Version 1.0
  23.  
  24.      - First release
  25.  
  26.  
  27. Version 1.1
  28.  
  29.      - Some minor bug fixes
  30.      - Deleted "include" for iffparse.h and changed project id line
  31.      - Depending on  used options,  sometimes no revision file would be written.
  32.        Fixed. Reported by Nelson Sandalwood. Thanks.
  33.      - Revisor is about 1k smaller now ;-).
  34.  
  35.  
  36.  
  37. Usage:
  38. ¯¯¯¯¯
  39. Command line template follows:
  40.  
  41. Revisor  PRG=PRGNAME,PRO=PROJECTNAME/K,VER=VERSION/N/K,REV=REVISION/N/K,
  42.          BETA/N/K,PROVER=PROJECTVERSION/N/K,PROREV=PROJECTREVISION/N/K,
  43.          DESC=DESCRIPTION/K,AUT=AUTHOR/K,COPY=COPYRIGHT/K,C/S,ASM/S,
  44.          CPPC=CPPCOMMENT/S,NOCPPC=NOCPPCOMMENT/S,BV=BUMPVER/S,BR=BUMPREV/S,
  45.          BB=BUMPBETA/S,RB=RESETBETA/S,BPV=BUMPPROJECTVER/S,
  46.          BPR=BUMPPROJECTREV/S";
  47.  
  48.  
  49. Yes,  i  know  that  this is a complex bulk of parameters, but it's very easy to
  50. handle.   The first time you create your revision file, you have to give most of
  51. the  named parameters to Revisor.  The second and all other times, you only have
  52. to  give  the  sections  you  want  to  update  or  bump.  Let  me  explain  the
  53. parameters:
  54.  
  55.  
  56.                  PRG=PRGNAME  - Here you must specify the program name for which
  57.                                 you want to create a revision file. You must not
  58.                                 add   any   extensions   like   ".c"  or ".h" or
  59.                                 something.
  60.  
  61.            PRO=PROJECTNAME/K  - After this  keyword you  give a  project name if
  62.                                 your program is not stand alone for example.
  63.  
  64.              VER=VERSION/N/K  - The ordinary version of your program.
  65.  
  66.             REV=REVISION/N/K  - Same for the revision parameter.
  67.  
  68.                     BETA/N/K  - Here you specify the beta version if one.
  69.  
  70.    PROVER=PROJECTVERSION/N/K  - This belongs to the project and is it's version.
  71.  
  72.   PROREV=PROJECTREVISION/N/K  - Belongs to the project too: Project revision.
  73.  
  74.           DESC=DESCRIPTION/K  - Here you  can give a short  description of  what
  75.                                 your program is for.
  76.  
  77.                 AUT=AUTHOR/K  - This is your name (in most cases).
  78.  
  79.             COPY=COPYRIGHT/K  - This is the copyright information.
  80.  
  81.                          C/S  - Use  this  switch  if  you  want  to create  a C
  82.                                 revision file.  The given PRGNAME parameter plus
  83.                                 "_rev.h" is the name of your revision file. This
  84.                                 is only for creation  time or if you want to add
  85.                                 a C revision file to your app.
  86.  
  87.                        ASM/S  - The switch for an  ASM file.  Same as above, but
  88.                                 the name is PRGNAME plus  "_rev.i".
  89.  
  90.            CPPC=CPPCOMMENT/S  - This tells Revisor to use C++ comment lines.
  91.  
  92.        NOCPPC=NOCPPCOMMENT/S  - Tells  Revisor to  NOT use  C++  comments.  Only
  93.                                 usefull if you  want to change you  existing C++
  94.                                 file to normal C-style.
  95.  
  96.  
  97.                 BV=BUMPVER/S  - With  this  switch,  you  bump  up your  program
  98.                                 version by 1 (from 2 to 3 for example)
  99.  
  100.                 BR=BUMPREV/S  - Same here, but for the revision.
  101.  
  102.                BB=BUMPBETA/S  - This bumps up your beta information by 1.
  103.  
  104.               RB=RESETBETA/S  - Same as BETA=0, but nicer ;-). Simply resets the
  105.                                 beta version back to zero.
  106.  
  107.         BPV=BUMPPROJECTVER/S  - Again the  same as  above,  but for your overall
  108.                                 project version number.
  109.  
  110.         BPR=BUMPPROJECTREV/S  - And  again  the  same as  above  for the project
  111.                                 revision.
  112.  
  113.  
  114. That's all folks!
  115.  
  116.  
  117.  
  118. Example use:
  119. ¯¯¯¯¯¯¯¯¯¯¯
  120. Let's  say  your  application  name  is  "App"  and  belongs to a project called
  121. "Project".  The current application state is version 1, revision 2 and your beta
  122. state  is  3.   For your whole project, the state is V1.1.  Because your program
  123. consist  of  C  and  ASM  files you need both, C and ASM revision files.  And at
  124. last,  you  want  to  use  C++ comments in the C revision file, because they are
  125. nicer.
  126.  
  127. For  creating  a  fully new revision file for your application use the following
  128. (sure, that you have to specify all parameters in one line ;-):
  129.  
  130.  
  131.     Revisor  App  PROJECTNAME       "Project"
  132.                   VERSION           1
  133.                   REVISION          2
  134.                   BETA              3
  135.                   PROJECTVERSION    1
  136.                   PROJECTREVISION   1
  137.                   DESCRIPTION       "My favorite application."
  138.                   AUTHOR            "your name"
  139.                   COPYRIGHT         "Copyright ©1998"
  140.                   C
  141.                   ASM
  142.                   CPPCOMMENT
  143.  
  144.  
  145. The resulting revision files look like this:
  146.  
  147. --------------------------------------------------------------------------------
  148.  
  149. // #############################################################################
  150. // ###
  151. // ###    App_rev.h    -    built automatically by Revisor 1.0
  152. // ###
  153. // ###
  154. // ###            Revisor        Copyright ©1998 by Carsten Scholling
  155. // ###                        All rights reserved.
  156. // ###
  157. // ###
  158. // ###        DO NOT EDIT BY HAND!!!
  159. // ###
  160. // #############################################################################
  161. #ifndef    APP_REV_H
  162. #define    APP_REV_H
  163.  
  164.  
  165. #include    <libraries/iffparse.h>
  166.  
  167.  
  168. #define    PROJECT_ID            MAKE_ID('P','R','O','J')
  169.  
  170. #define    PROJECTNAME            "Project"
  171. #define    NAME                "App"
  172. #define    DESCRIPTION            "My favorite application."
  173. #define    FULLNAME            "App - My favorite application."
  174. #define    AUTHOR                "your name"
  175. #define    COPYRIGHT            "Copyright ©1998"
  176.  
  177. #define    PROJECTVERSION        1
  178. #define    PROJECTREVISION        1
  179. #define    VERSION                1
  180. #define    REVISION            2
  181. #define    BETAVERSION            3
  182.  
  183. #define    DATE                "24.02.98"
  184. #define    TIME                "19:41:06"
  185. #define    DAY                    "Dienstag"
  186.  
  187. #define    VERSION_STRING        "1.2ß3"
  188. #define    FULLVERSION_STRING    "1.2ß3 (24.02.98)"
  189.  
  190. #define    VERS                "App 1.2ß3"
  191. #define    VSTRING                "App 1.2ß3 (24.02.98)\r\n"
  192. #define    VERSTAG                "\0$VER: App 1.2ß3 (24.02.98)"
  193.  
  194. #define    CATALOG_NAME        "app.catalog"
  195. #define    CATALOG_VERSION        1
  196.  
  197. #endif    // APP_REV_H
  198.  
  199. --------------------------------------------------------------------------------
  200.  
  201. ******************************************************************************
  202. *
  203. *    App_rev.i    -    built automatically by Revisor 1.0
  204. *
  205. *
  206. *            Revisor        Copyright ©1998 by Carsten Scholling
  207. *                        All rights reserved.
  208. *
  209. *    
  210. *        DO NOT EDIT BY HAND!!!
  211. *
  212. ******************************************************************************
  213.  
  214.  
  215. PROJECTNAME            MACRO
  216.                     dc.b    'Project'
  217.                     ENDM
  218.  
  219. NAME                MACRO
  220.                     dc.b    'App'
  221.                     ENDM
  222.  
  223. DESCRIPTION            MACRO
  224.                     dc.b    'My favorite application.'
  225.                     ENDM
  226.  
  227. FULLNAME            MACRO
  228.                     dc.b    'App - My favorite application.'
  229.                     ENDM
  230.  
  231. AUTHOR                MACRO
  232.                     dc.b    'your name'
  233.                     ENDM
  234.  
  235. COPYRIGHT            MACRO
  236.                     dc.b    'Copyright ©1998'
  237.                     ENDM
  238.  
  239. PROJECTVERSION        EQU        1
  240. PROJECTREVISION        EQU        1
  241. VERSION                EQU        1
  242. REVISION            EQU        2
  243. BETAVERSION            EQU     3
  244.  
  245. DATE                MACRO
  246.                     dc.b    '24.02.98'
  247.                     ENDM
  248.  
  249. TIME                MACRO
  250.                     dc.b    '19:41:06'
  251.                     ENDM
  252.  
  253. DAY                    MACRO
  254.                     dc.b    'Dienstag'
  255.                     ENDM
  256.  
  257. VERSION_STRING        MACRO
  258.                     dc.b    '1.2ß3'
  259.                     ENDM
  260.  
  261. FULLVERSION_STRING    MACRO
  262.                     dc.b    '1.2ß3 (24.02.98)'
  263.                     ENDM
  264.  
  265. VERS                MACRO
  266.                     dc.b    'App 1.2ß3'
  267.                     ENDM
  268.  
  269. VSTRING                MACRO
  270.                     dc.b    'App 1.2ß3 (24.02.98)',13,10,0
  271.                     ENDM
  272.  
  273. VERSTAG                MACRO
  274.                     dc.b    0,'$VER: App 1.2ß3 (24.02.98)',0
  275.                     ENDM
  276.  
  277. CATALOG_NAME        MACRO
  278.                     dc.b    'app.catalog'
  279.                     ENDM
  280.  
  281. CATALOG_VERSION        EQU        1
  282.  
  283. --------------------------------------------------------------------------------
  284.  
  285.  
  286. So.   The  time runs away and your application is out of the beta state and it's
  287. time  to  release your stuff.  So you have to reset the beta version to 0.  This
  288. is done by:
  289.  
  290.     Revisor  App  RESETBETA
  291.  
  292. or
  293.  
  294.     Revisor  App  BETA 0
  295.  
  296.  
  297.  
  298. Two  month later (you have forgotten to increase the revision meanwhile ;-), you
  299. want to release the next version V1.3. Simply type:
  300.  
  301.     Revisor  App  BUMPREV
  302.  
  303.  
  304.  
  305. If   you   only   want   to   make  some  minor  changes  without  updating  the
  306. version/revision information, but want to be up to DATE, simply use
  307.  
  308.     Revisor  App
  309.  
  310. This  will  update the date and time information each time you call Revisor (out
  311. of a makefile for example).
  312.  
  313.  
  314.  
  315. Now,  two  years  ago,  you have changed thousands of  source lines and  want to
  316. update to V2.0, project version 2.0. This is very easy too:
  317.  
  318.     Revisor  App  BUMPVER BUMPPROJECTVER
  319.  
  320.  
  321.  
  322. Sure that you can change all the information every time by simply typing
  323.  
  324.     Revisor  App  DESC "New description"  AUTHOR "New author"
  325.  
  326. or something.
  327.  
  328.  
  329.  
  330.  
  331.  
  332. So.   Think  you  are  now familar with Revisor.  But if you encounter any bugs,
  333. have  new  ideas or needings or simply want to write me a mail, because you find
  334. Revisor usefull, here my email address:
  335.  
  336.  
  337.     cscholling@t-online.de
  338.  
  339.  
  340. ============================= Archive contents =============================
  341.  
  342. Original  Packed Ratio    Date     Time    Name
  343. -------- ------- ----- --------- --------  -------------
  344.    15764    7654 51.4% 05-Apr-98 15:08:54  Revisor
  345.     9424    3106 67.0% 05-Apr-98 15:11:24  Revisor.readme
  346. -------- ------- ----- --------- --------
  347.    25188   10760 57.2% 05-Apr-98 19:21:54   2 files
  348.